Next: , Previous: Options (Creating Labels), Up: Options


8.4 Referencing Labels

— User Option: reftex-label-menu-flags

List of flags governing the label menu makeup. The flags are:

table-of-contents
Show the labels embedded in a table of context.
section-numbers
Include section numbers (like 4.1.3) in table of contents.
counters
Show counters. This just numbers the labels in the menu.
no-context
Non-nil means do not show the short context.
follow
Follow full context in other window.
show-commented
Show labels from regions which are commented out.
match-everywhere
Obsolete flag.
show-files
Show begin and end of included files.

Each of these flags can be set to t or nil, or to a string of type letters indicating the label types for which it should be true. These strings work like character classes in regular expressions. Thus, setting one of the flags to ‘"sf"’ makes the flag true for section and figure labels, nil for everything else. Setting it to ‘"^sf"’ makes it the other way round.

The available label types are: s (section), f (figure), t (table), i (item), e (equation), n (footnote), plus any definitions in reftex-label-alist.

Most options can also be switched from the label menu itself - so if you decide here to not have a table of contents in the label menu, you can still get one interactively during selection from the label menu.

— User Option: reftex-multiref-punctuation

Punctuation strings for multiple references. When marking is used in the selection buffer to select several references, this variable associates the 3 marking characters ‘,-+’ with prefix strings to be inserted into the buffer before the corresponding \ref macro. This is used to string together whole reference sets, like ‘eqs. 1,2,3-5,6 and 7’ in a single call to reftex-reference.

— User Option: reftex-vref-is-default

Non-nil means, the varioref macro \vref is used as default. In the selection buffer, the v key toggles the reference macro between \ref and \vref. The value of this variable determines the default which is active when entering the selection process. Instead of nil or t, this may also be a string of type letters indicating the label types for which it should be true.

— User Option: reftex-fref-is-default

Non-nil means, the fancyref macro \fref is used as default. In the selection buffer, the V key toggles the reference macro between \ref, \fref and \Fref. The value of this variable determines the default which is active when entering the selection process. Instead of nil or t, this may also be a string of type letters indicating the label types for which it should be true.

— Hook: reftex-format-ref-function

If non-nil, should be a function which produces the string to insert as a reference. Note that the insertion format can also be changed with reftex-label-alist. This hook also is used by the special commands to insert \vref and \fref references, so even if you set this, your setting will be ignored by the special commands. The function will be called with two arguments, the label and the default-format (usually ‘~\ref{%s}’). It should return the string to insert into the buffer.

— User Option: reftex-level-indent

Number of spaces to be used for indentation per section level.

— User Option: reftex-guess-label-type

Non-nil means, reftex-reference will try to guess the label type. To do that, RefTeX will look at the word before the cursor and compare it with the magic words given in reftex-label-alist. When it finds a match, RefTeX will immediately offer the correct label menu - otherwise it will prompt you for a label type. If you set this variable to nil, RefTeX will always prompt for a label type.

— Normal Hook: reftex-display-copied-context-hook

Normal Hook which is run before context is displayed anywhere. Designed for X-Symbol, but may have other uses as well.

— Hook: reftex-pre-refontification-functions

X-Symbol specific hook. Probably not useful for other purposes. The functions get two arguments, the buffer from where the command started and a symbol indicating in what context the hook is called.

— Normal Hook: reftex-select-label-mode-hook

Normal hook which is run when a selection buffer enters reftex-select-label-mode.

— Keymap: reftex-select-label-map

The keymap which is active in the labels selection process (see Referencing Labels).